Skip to content

JOSS paper preparation - #1249

Open
danielfromearth wants to merge 45 commits into
mainfrom
joss-paper
Open

danielfromearth wants to merge 45 commits into
mainfrom
joss-paper

Conversation

@danielfromearth

@danielfromearth danielfromearth commented Mar 5, 2026

Copy link
Copy Markdown
Contributor

Manuscript draft

This PR is intended for revisions and improvements to the manuscript draft being prepared for submission to the Journal of Open Source Software (JOSS).

Paper format: The manuscript is prepared as a Markdown (paper.md) file with references in a paper.bib file, following the JOSS formatting guidelines.

For a PDF preview: With docker installed locally, a PDF preview of the draft manuscript can be generated, by running the following from the earthaccess root directory (as described in the JOSS guidelines's docker section):

docker run --rm \
    --volume $PWD/paper:/data \
    --user $(id -u):$(id -g) \
    --env JOURNAL=joss \
    openjournals/inara

Author sign-off

Approvals below apply to the manuscript as of 06dce59 and carry forward through later commits that don't change meaning, such as typos, line wrapping, .bib formatting. If a revision meaningfully changes the substance of the manuscript, I'll clear the affected rows and ping those authors directly.

To sign off: confirm your author entry (name, affiliation, ORCID) is correct and that you approve the current draft — reply here, approve the PR, or message me in Slack.

Author Approves draft note
@andypbarrett via Slack
@battistowx via GH review
@jrbourbeau via GH review
@itcarroll via GH review
@chuckwondo via GH review
@mfisher87
@danielfromearth via comment
@jhkennedy via GH review
@betolink via GH review
@jules32 via GH review
@JessicaS11
@asteiker via GH review
@Sherwin-14 via GH review

Related pyOpenSci review issue: pyOpenSci/software-submission#302


📚 Documentation preview 📚: https://earthaccess--1249.org.readthedocs.build/en/1249/

@github-actions

github-actions Bot commented Mar 5, 2026

Copy link
Copy Markdown

Binder 👈 Launch a binder notebook on this branch for commit 16fb7b9

I will automatically update this comment whenever this PR is modified

Binder 👈 Launch a binder notebook on this branch for commit 38cad6a

Binder 👈 Launch a binder notebook on this branch for commit 96f6e46

Binder 👈 Launch a binder notebook on this branch for commit 69155cd

Binder 👈 Launch a binder notebook on this branch for commit b00d317

Binder 👈 Launch a binder notebook on this branch for commit f7e346c

@jules32 jules32 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi! Great work on this Danny! A few commits and some suggestions to consider.

Comment thread paper/paper.md Outdated
Comment thread paper/paper.md
Comment thread paper/paper.md
Comment thread paper/paper.md Outdated
Comment thread paper/paper.md Outdated
Comment thread paper/paper.md Outdated
Comment thread paper/paper.md
Comment thread paper/paper.md Outdated
Comment thread paper/paper.md Outdated
@mfisher87

Copy link
Copy Markdown
Member

after the v1.0.0 release

I would say let's not wait. We've demonstrated impact and I think that matters more.

Alternatively, let's just go 1.0.0 in the short term and be OK with quickly moving to a 2.0.0 release with breaking changes.

I think both are fine, but the latter sets more a precedent of maintainers taking the user impact of breaking changes too lightly.

Co-authored-by: Matt Fisher <3608264+mfisher87@users.noreply.github.com>
@danielfromearth danielfromearth changed the title Joss paper JOSS paper preparation Mar 6, 2026
@danielfromearth

Copy link
Copy Markdown
Contributor Author

after the v1.0.0 release

I would say let's not wait. We've demonstrated impact and I think that matters more.

Alternatively, let's just go 1.0.0 in the short term and be OK with quickly moving to a 2.0.0 release with breaking changes.

I think both are fine, but the latter sets more a precedent of maintainers taking the user impact of breaking changes too lightly.

I'm fine with either too. I also think the decision could be on hold until one of the two things – (i) co-author reviews/revisions, (ii) development for v1.0.0 – is completely ready-to-go.

- remove "ongoing" since (a) it's mostly done and (b) won't be ongoing for future readers.
- remove residual redundancy from Earthdata Cloud rewording
- backtick VirtualiZarr, kerchunk, and xarray package names throughout

Co-authored-by: Ian Carroll <ian.t.carroll@nasa.gov>
@danielfromearth

danielfromearth commented Sep 9, 2026

Copy link
Copy Markdown
Contributor Author

Sign-off tracking has moved to the PR description.

I've added an author sign-off table there. I'll track approvals against 06dce59 as a baseline and carry forward through editorial commits (typos, line wrapping, .bib formatting), so you won't be asked to re-approve in case we make additional small edits. If anything substantive changes, I'll clear the affected rows and ping those authors directly.

What I need from each of you:

(@JessicaS11, @mfisher87)

  1. Confirm your name, affiliation, and ORCID are correct in the author list.
  2. Confirm you approve the current draft and agree to be listed as an author.

Item 1 takes about fifteen seconds. Reply here, approve the PR, or message me in Slack – and I'll keep the table updated either way.

By 23 September: if I haven't heard from you, I'll take that as no further edits requested.

Though, if you'd like more time, let me know!

Comment thread paper/paper.md Outdated
Co-authored-by: Chuck Daniels <chuck@developmentseed.org>
chuckwondo
chuckwondo previously approved these changes Sep 9, 2026

@chuckwondo chuckwondo left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for tweaking the DevSeed entry @danielfromearth!

jrbourbeau
jrbourbeau previously approved these changes Sep 9, 2026
asteiker
asteiker previously approved these changes Sep 9, 2026

@asteiker asteiker left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Confirmed my author info and gave it another quick read. Looks great, thank you so much @danielfromearth for leading this!

betolink
betolink previously approved these changes Sep 10, 2026

@betolink betolink left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great work team! thanks for leading this effort @danielfromearth!

Comment thread paper/paper.md Outdated

@Sherwin-14 Sherwin-14 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @danielfromearth ! Approved from my side.

Comment thread paper/paper.md Outdated
Comment thread paper/paper.md
Comment thread paper/paper.md Outdated
Comment thread paper/paper.md Outdated
Comment thread paper/paper.md Outdated
Comment thread paper/paper.md Outdated
JessicaS11
JessicaS11 previously approved these changes Sep 15, 2026

@JessicaS11 JessicaS11 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great - thanks, Danny!

Updated the ror for my affiliations and left a few suggested edits about commas and passive voice. Pending the ror correction, I approve both 1 and 2.

Co-authored-by: Jessica Scheick <JessicaS11@users.noreply.github.com>
battistowx
battistowx previously approved these changes Sep 18, 2026
Comment thread paper/paper.md Outdated
Comment thread paper/paper.md Outdated
Co-authored-by: Daniel Kaufman <114174502+danielfromearth@users.noreply.github.com>
Co-authored-by: Jessica Scheick <JessicaS11@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

impact: documentation Use this label for issues related to Improvements or additions to documentation.

Projects

None yet

Development

Successfully merging this pull request may close these issues.